<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.11.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Lesson Project: C:/Users/ttl/Documents/Lesson/Lesson_Project/T4056_Eternal_Watch/03_Firmware/Temp/User/Driver/LED/Inc/led_driver.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Lesson Project<span id="projectnumber">&#160;Beta V1.1</span>
   </div>
   <div id="projectbrief">Course Learning Template Engineering</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.11.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){ initResizable(false); });
/* @license-end */
</script>
<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_6d4e12d46ad8519ff7b80e874016d102.html">User</a></li><li class="navelem"><a class="el" href="dir_81f18e0c07fff3e9102b10505e4dbf14.html">Driver</a></li><li class="navelem"><a class="el" href="dir_360e7d3b387520a2bbb10bb361dd28fa.html">LED</a></li><li class="navelem"><a class="el" href="dir_1b54057a9af423fd69e567f4284a4bbf.html">Inc</a></li>  </ul>
</div>
</div><!-- top -->
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle"><div class="title">led_driver.h File Reference</div></div>
</div><!--header-->
<div class="contents">

<p>led driver harder file  
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;stdlib.h&gt;</code><br />
<code>#include &lt;string.h&gt;</code><br />
<code>#include &quot;stm32f4xx_hal.h&quot;</code><br />
<code>#include &quot;stm32f4xx_hal_gpio.h&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for led_driver.h:</div>
<div class="dyncontent">
<div class="center"><img src="led__driver_8h__incl.png" border="0" usemap="#a_c_1_2_users_2ttl_2_documents_2_lesson_2_lesson___project_2_t4056___eternal___watch_203___firmware_2_temp_2_user_2_driver_2_l_e_d_2_inc_2led__driver_8h" alt=""/></div>
</div>
</div><div class="textblock"><div class="dynheader">
This graph shows which files directly or indirectly include this file:</div>
<div class="dyncontent">
<div class="center"><img src="led__driver_8h__dep__incl.png" border="0" usemap="#a_c_1_2_users_2ttl_2_documents_2_lesson_2_lesson___project_2_t4056___eternal___watch_203___firmware_2_temp_2_user_2_driver_2_l_e_d_2_inc_2led__driver_8hdep" alt=""/></div>
</div>
</div>
<p><a href="led__driver_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structpin__attr__t.html">pin_attr_t</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">struct of pin attribute  <a href="structpin__attr__t.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structpin__driver__t.html">pin_driver_t</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">struct of pin driver  <a href="structpin__driver__t.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structpin__driver__ops.html">pin_driver_ops</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">struct of pin driver oprations  <a href="structpin__driver__ops.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a16b42fed569806b648c13c4fc95d35d6" id="r_a16b42fed569806b648c13c4fc95d35d6"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structpin__driver__ops.html">pin_driver_ops</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a16b42fed569806b648c13c4fc95d35d6">pin_driver_ops_t</a></td></tr>
<tr class="memdesc:a16b42fed569806b648c13c4fc95d35d6"><td class="mdescLeft">&#160;</td><td class="mdescRight">struct of pin driver oprations  <br /></td></tr>
<tr class="separator:a16b42fed569806b648c13c4fc95d35d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a099fe16b9c572777e3811a5513ebaa34" id="r_a099fe16b9c572777e3811a5513ebaa34"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a099fe16b9c572777e3811a5513ebaa34">pin_type_e</a> { <a class="el" href="#a099fe16b9c572777e3811a5513ebaa34ad2179252cdaadcf8ef91427d7c67f922">PIN_TYPE_BLUE</a> = 0
, <a class="el" href="#a099fe16b9c572777e3811a5513ebaa34a16a1ba0a286d84932444c4bae35285e4">PIN_TYPE_MAX</a>
 }</td></tr>
<tr class="memdesc:a099fe16b9c572777e3811a5513ebaa34"><td class="mdescLeft">&#160;</td><td class="mdescRight">struct of pin attribute  <a href="#a099fe16b9c572777e3811a5513ebaa34">More...</a><br /></td></tr>
<tr class="separator:a099fe16b9c572777e3811a5513ebaa34"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a29f61f4f947d72aa4cec57fbccb4d2b4" id="r_a29f61f4f947d72aa4cec57fbccb4d2b4"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a29f61f4f947d72aa4cec57fbccb4d2b4">pin_driver_register</a> (<a class="el" href="structpin__driver__t.html">pin_driver_t</a> *me, <a class="el" href="#a099fe16b9c572777e3811a5513ebaa34">pin_type_e</a> pin_type, const char *pin_name)</td></tr>
<tr class="memdesc:a29f61f4f947d72aa4cec57fbccb4d2b4"><td class="mdescLeft">&#160;</td><td class="mdescRight">pin driver register  <br /></td></tr>
<tr class="separator:a29f61f4f947d72aa4cec57fbccb4d2b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>led driver harder file </p>
<dl class="section author"><dt>Author</dt><dd>T4056 Student </dd></dl>
<dl class="section date"><dt>Date</dt><dd>2024-07-20 </dd></dl>
<dl class="section version"><dt>Version</dt><dd>V1.0 </dd></dl>
<dl class="section user"><dt>Copyright(c):</dt><dd>T4056 Student.All rights reserved. </dd></dl>

<p class="definition">Definition in file <a class="el" href="led__driver_8h_source.html">led_driver.h</a>.</p>
</div><h2 class="groupheader">Typedef Documentation</h2>
<a id="a16b42fed569806b648c13c4fc95d35d6" name="a16b42fed569806b648c13c4fc95d35d6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a16b42fed569806b648c13c4fc95d35d6">&#9670;&#160;</a></span>pin_driver_ops_t</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef struct <a class="el" href="structpin__driver__ops.html">pin_driver_ops</a> <a class="el" href="#a16b42fed569806b648c13c4fc95d35d6">pin_driver_ops_t</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>struct of pin driver oprations </p>
<p>init set_state get_state toggle </p><dl class="todo"><dt><b><a class="el" href="todo.html#_todo000001">Todo</a></b></dt><dd>add function _set_mode _get_mode _set_pull _set_pull <br  />
 </dd></dl>

</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="a099fe16b9c572777e3811a5513ebaa34" name="a099fe16b9c572777e3811a5513ebaa34"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a099fe16b9c572777e3811a5513ebaa34">&#9670;&#160;</a></span>pin_type_e</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="#a099fe16b9c572777e3811a5513ebaa34">pin_type_e</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>struct of pin attribute </p>
<p>name port num state mode pull init </p><dl class="section note"><dt>Note</dt><dd>All GPIO pins should be defined here, including LED, KEY </dd></dl>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a099fe16b9c572777e3811a5513ebaa34ad2179252cdaadcf8ef91427d7c67f922" name="a099fe16b9c572777e3811a5513ebaa34ad2179252cdaadcf8ef91427d7c67f922"></a>PIN_TYPE_BLUE&#160;</td><td class="fielddoc"><p>PIN LED <br  />
 </p>
</td></tr>
<tr><td class="fieldname"><a id="a099fe16b9c572777e3811a5513ebaa34a16a1ba0a286d84932444c4bae35285e4" name="a099fe16b9c572777e3811a5513ebaa34a16a1ba0a286d84932444c4bae35285e4"></a>PIN_TYPE_MAX&#160;</td><td class="fielddoc"><p>PIN MAX NUM. </p>
</td></tr>
</table>

<p class="definition">Definition at line <a class="el" href="led__driver_8h_source.html#l00024">24</a> of file <a class="el" href="led__driver_8h_source.html">led_driver.h</a>.</p>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a29f61f4f947d72aa4cec57fbccb4d2b4" name="a29f61f4f947d72aa4cec57fbccb4d2b4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a29f61f4f947d72aa4cec57fbccb4d2b4">&#9670;&#160;</a></span>pin_driver_register()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int pin_driver_register </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structpin__driver__t.html">pin_driver_t</a> *</td>          <td class="paramname"><span class="paramname"><em>me</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="#a099fe16b9c572777e3811a5513ebaa34">pin_type_e</a></td>          <td class="paramname"><span class="paramname"><em>pin_type</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *</td>          <td class="paramname"><span class="paramname"><em>pin_name</em></span>&#160;)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>pin driver register </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">me</td><td></td></tr>
    <tr><td class="paramname">pin_type</td><td></td></tr>
    <tr><td class="paramname">pin_name</td><td></td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0:register success! 1:register failure,the wrong is pin name's length</dd></dl>
<p>get pin attribute from name </p><dl class="section note"><dt>Note</dt><dd>it's should add some assert or trace function </dd></dl>

<p class="definition">Definition at line <a class="el" href="led__driver_8c_source.html#l00111">111</a> of file <a class="el" href="led__driver_8c_source.html">led_driver.c</a>.</p>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.11.0
</small></address>
</div><!-- doc-content -->
</body>
</html>
